home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 049a / xuc42.zip / XUC.DOC < prev    next >
Text File  |  1991-09-08  |  20KB  |  451 lines
  1.  
  2.  
  3.                         **     **  **   **   ****** 
  4.                          **   **   **   **  **    **
  5.                           ** **    **   **  **      
  6.                            ***     **   **  **      
  7.                           ** **    **   **  **      
  8.                          **   **   **   **  **    **
  9.                         **     **   *****    ******
  10.  
  11.                                 Version 4.2
  12.  
  13.                      * The eXpress Userlist Compiler *
  14.  
  15.                     (C) Copyright Artwork Software 1991
  16.                          Written by Michael Barnes
  17.                             All Rights Reserved
  18.  
  19.                       This release finished on 27/8/91
  20.  
  21.                                 ┌─┬───┬─┐
  22.                                 ├─┘ _ └─┤rtwork
  23.                                 │  (_)  │
  24.                                 │ ┌───┐ │  .
  25.                                 │ │■ █│ │ /
  26.                                 └─┴───┴─┘/
  27.                                          \
  28.                                           \ oftware
  29.                                           /
  30.                                         ./
  31.  
  32.            "Quality Shareware software for the IBM Compatible PC"
  33.  
  34.  
  35. P L E A S E  N O T E ! ! !
  36. ==========================
  37.  
  38.   My netmail address is now 2:252/125, instead of 2:252/7. Netmail to
  39. 2:252/7 will still reach me as that is the board I collecting mail from. If
  40. the 2:252/125 address disappears (the future of the BB is a little
  41. uncertain) then go back to using 2:252/7.
  42.  
  43.   Users of pervious versions will find several large changes in this
  44. version. Please don't try and use it without reading the documentation, or
  45. you may regret it!
  46.  
  47. ============================================================================
  48. License    !!!!!  I M P O R T A N T  P L E A S E  R E A D  !!!!!! 
  49. ============================================================================
  50.  
  51.   The license for XUC is as follows... You can try out XUC absolutely free
  52. for 30 days. After that period of time, I must ask you to register. There is
  53. no way for me to *make* you register, but I hope the program is sufficiently
  54. useful to warrant it's registration. I've spent a fair number of hours
  55. working on it (far more than I'd like to admit), and the very modest fee is
  56. designed to allow even the poorest user to register. I fear that the effect
  57. may be the opposite to that which I want - because the price is low, people
  58. think it's not worth registering. I hope that this isn't the case, but if it
  59. is then there's a simple solution...
  60.  
  61.   Anyway, whether you are registered or not, you are welcome to any help
  62. that you require, so long as I can provide that help.
  63.  
  64.   If you want to purchase a number of copies, bulk discounts may be
  65. available. ONE purchase equals ONE user - there is no other arrangement.
  66.  
  67.   The above extends back to all previous versions of XUC.
  68.  
  69.   The registration fee is 5 pounds sterling (quid=pound, for you foriegn
  70. users who might be confused by the term!). If you've already paid, you're
  71. already registered - registration is for life and all future versions.
  72.  
  73.  
  74. Introduction
  75. ------------
  76.  
  77. There's a saying in the world of software writing - "If you spend as much
  78. time testing as you need to, you'd never get the program out the door." At
  79. least, if there isn't there should be. It's true.
  80.  
  81. Where to strike the balance between reliability and time is the problem - I
  82. use the "it seems to work" principle, which states: "If it seems to work
  83. then release it - to hell with the little lurking bugs."
  84.  
  85. Well, little lurking bugs are often actually big lurking bugs in disguise,
  86. as has been demonstrated adequately with previous versions of XUC. I'd hoped
  87. that no more demonstrations would be necessary, but they have been... So
  88. here's another release. XUC V4 didn't work. Quite simply, it was a load of
  89. doggy do. Somehow I'd managed to forget to make it check to see if it had
  90. already extracted the record it has just extracted already (got that? it
  91. means "dupe checking"), except for looking at the last record. Oops. Also,
  92. I'd missed out the vital word "Var" in one of my procedure declarations - if
  93. you know Turbo Pascal, you'll know that this would mean that parameters are
  94. not returned. Put simply, it was a cock up which meant that all point
  95. numbers were wrong - except those that weren't.
  96.  
  97. I've also made the node number extraction a little better, which is an
  98. improvement rather than a bug fix. A little weeny bug in the browser has
  99. also been removed.
  100.  
  101. That was all true for V4.1, which was a bug-fix in a minor sort of way. This
  102. new version includes a few new things including some more keywords in the
  103. control file (look at the XUC.Ctl file itself for info on those). Browser
  104. now also includes an echomail statistics section, and the PgUp and PgDn keys
  105. work. Browser accepts command-line options, for use with XRS macros when
  106. they arrive. The search facility will write all the node numbers of matching
  107. entries into a file called "Found.Xuc", from which XRS may conceivably grab
  108. them in the future - basically this feature allows XUC to create results
  109. which can be used by another program. And a few bugs have been squashed too.
  110.  
  111.  
  112. ***  I ought to just point out that you really ought to read the "Other
  113.      Programs" bit at the end of this document. Address Master is a pretty
  114.      neat program, which I hope will go a long way. It also includes USA
  115.      support now (meaning it will convert "Postcode" to "Zip Code" - not a
  116.      big change but nifty!).
  117.  
  118.  
  119. The Programs and How to Use them
  120. --------------------------------
  121.  
  122. Convert
  123. -------
  124.  
  125. "Convert" will convert your old userlist style list into the new XUC style
  126. userfile. XUC now uses it's own format for the userfile - see below for more
  127. details.
  128.  
  129. Convert has four command line parameters you can use.
  130.  
  131. -U:<FileName>  -    Specify userlist to convert ("Userlist.XRS" default).
  132. -W             -    If the userlist is in 58 column mode, use this!
  133. -N             -    Don't process entries where the username contains a
  134.                     numbers.
  135. -J             -    Don't process entries with characters of ascii value
  136.                     higher than 126 or lower than 32.
  137.  
  138.  
  139. XUC
  140. ---
  141.  
  142.   XUC is a utility that you can run after you've read your mail which will
  143. look through the mailbag and extract the names and Net/Node addresses of the
  144. originators of messages which fulfill the following requirements.
  145.  
  146. a)   They must have an address! Some boards seem to produce mail which does
  147.      not have an address in it. This is, I think, against FidoNet policy so
  148.      please ask sysops producing messages with no address on the origin line
  149.      to stop it! If a "^AMSGID" control flag is found in the message, the
  150.      node number will be taken from that. This also works for "^AFROM" -
  151.      assuming I've got the specs for this right!
  152.  
  153. b)   They must have the address (if the ^AMSGID or ^AFROM isn't used) 
  154.      surrounded by brackets "(" and ")". Text in the brackets is ignored
  155.      until a zone number and a colon (":") is found. Thus if there is, for
  156.      some reason, a number that has been specified in the control file - or
  157.      if none specified then the defaults of 1 to 5 - followed by a colon
  158.      *before* the actual address, the resulting address will be invalid.
  159.  
  160. c)   The zone number must be preceded by either a space or an open bracket
  161.      "(". There should *never* be any other arrangement - if there is,
  162.      please tell me!
  163.  
  164.   Any messages where any of the above requirements are not met will be
  165. ignored. You should find, if you're getting all the zones, that you're
  166. getting around a quarter of the total number of messages. The reason it's
  167. that low is because it only takes each person once!
  168.   The simplest way of running XUC is to just type "XUC" at the command line.
  169. This will set XUC going on a default mailbag of "Bat1mail.XRS". If your
  170. mailbags have a different name from this, you need to run XUC by typing:
  171.  
  172.      "XUC -B<Name of MailBag.Extension>"
  173.  
  174.           or use the control file to change the default. If there is no
  175. control file, XUC will use built-in default values.
  176.   You *must* give XUC the entire filename.
  177.  
  178.   Once XUC has extracted the names and Net/Node numbers it will sort them
  179. and write them out to a file called "UserAdd.XUC". XUC then merges this
  180. sorted userfile file with your main userfile. Where there are duplications
  181. of name, XUC will add the new name. If the node number (*not* including the
  182. point number) is the same the new entry won't be added. "What?" I hear you
  183. say... "duplicates allowed?". Yup! The "Browser" program, included in the
  184. package, will search the userlist succesfully with or without duplicates.
  185. Hopefully Mike Ratledge will support the new file format soon. But don't
  186. worry - if you ask XUC nicely, it will produce an old-style userlist too.
  187.  
  188.   To create a userlist, use the "-M" command line parameter, or use the
  189. keyword "MakeList" as described in the XUC.CTL file.
  190.  
  191.   A whole host of new keywords have been added to the XUC.CTL range. Read
  192. what I've written in the XUC.CTL file for full details.
  193.  
  194.   One thing to remember is that XUC has a 850 address limit. If it manages
  195. to extract that many, it should ignore any that come after. As the number of
  196. messages you can download in one session is limited, there shouldn't be any
  197. problem at all with this!
  198.  
  199.   Incidently, the "comment" field in the program is not a text field, it's a
  200. pointer to another record in a file called "Comments.Xuc". This means that
  201. if you don't write a comment, you don't take up much disk space! The down
  202. side is that this sort of thing is prone to problems if the links go wrong.
  203. This may happen if my programming is as bad there as it is everywhere else,
  204. or ot may happen due to disk errors. It will also happen if you delete the
  205. Userfile.Xuc file or the Comments.Xuc file without deleting the other (ie:
  206. if you delete one, make sure you delete the other!).
  207.  
  208. Browser
  209. -------
  210.  
  211. This program gives you a whole host of features, none very complex.
  212.  
  213. Add:      "A" -     You can add a user to the userlist. You must then merge
  214.                     ("M") the new record or records with the database.
  215.  
  216. Delete:   "D" -     Tag a user for deletion. You must then pack the database
  217.                     ("P") to remove tagged records.
  218.  
  219. By Date:  "B" -     Tag for deletion all users written to the userfile
  220.                     before a specific date.
  221.  
  222. Edit:     "E" -     Edit the nodenumber of the highlighted user.
  223.  
  224. Search:   "S" -     Search by string or part of a string for any user.
  225.  
  226. Details:  "Return" -     This will show you the full stored details on any
  227.                          user. Pressing "N" while in extended view mode will
  228.                          search the nodelist (if there is one) for the
  229.                          details of the BBS. More on that later.
  230.  
  231. Help:     "?" -     This will give you a summary of all commands.
  232.  
  233. If you are a sysop, or a keen user, you may have a nodelist handy. You'll
  234. need a nodelist compiler such as Parselist, and you should use this or a
  235. similar program to create a nodelist in one of the formats supported by
  236. Browser. Tell Browser which type of nodelist to use, and where to find it,
  237. using the two keywords "Nodelist" and "NodePath". You can then use Browser's
  238. lookup function to find the name and telephone number of the user's BBS. The
  239. nodelist routines were written by Mark Cole, who's such a brilliant chap
  240. that they actually work, and work well, so a big hand for Mark please.
  241.  
  242. In V4.2, when you do a search Browser writes the results to a file called
  243. Found.Xuc. This file is in the format:
  244.  
  245. Barnes, Michael, 2:252/125.0
  246.  
  247. This may be useful to someone.
  248.  
  249. Browser now has a few command line options. These are:
  250.  
  251.  -!       This tells Browser to display echomail statistics automatically
  252.           when you load the program.
  253.  
  254.  -A       Browser will automatically show extended info on a record which
  255.           you find using the search facility.
  256.  
  257.  -S<Name> Automatically search for <Name>. Note that spaces in the name
  258.           should be replaced with underscore characters -  
  259.                ie:  -SMichael_Barnes.
  260.           This feature is not case sensitive.
  261.  
  262.  -N       With this option, Browser will automatically look up a board's
  263.           details in the nodelist from the "extended view" section.
  264.  
  265. These new additions should allow XUC to work with the upcoming XRS V5 macro
  266. options. Then again they may not. That's the trouble with being ahead of the
  267. game for once (unles V5 is already out, in which case I'm behind again).
  268.  
  269.  
  270. Bugs!, Bug Reports, and FeedBack
  271. --------------------------------
  272.  
  273.   If you find a bug, don't keep it to yourself! Write to me by snailmail
  274. (address below), Netmail me at 2:252/125, or use any echo which seems
  275. appropriate (QMX_XRS is a good bet). If you think of something you think I
  276. should add, I'm open to suggestions as well as criticism. This fourth
  277. version has been written from ideas from users. I hope everyone is happy
  278. with it, if not please feel free to tell me exactly what you think!
  279.   This documentation was dashed off in one mega finger-killing, keyboard
  280. bashing exercise. Well, that's not quite true by now - several re-writes
  281. have been required, but why spoil a good line? If you spot a gruesome error
  282. in it, please tell me! There shouldn't be any spelling errors, but Word
  283. Perfect won't spot them darned grammatical errors...
  284.  
  285.  
  286. New features in V4.2
  287. --------------------
  288.  
  289. 1)   Browser command line options.
  290. 2)   Browser keywords in the Xuc.Ctl file.
  291. 3)   PgUp and PgDn work in Browser now.
  292. 4)   The merge in XUC and Browser was improved to make it work properly with
  293.      duplicate names.
  294. 5)   Echomail statistics section added in Browser.
  295. 6)   It probably now doesn't work either, but there's a large probability
  296.      that some it it that didn't work before now works to some extent. The
  297.      reverse is probably also true. I've discovered that the comments can go
  298.      walkies quite often - I'll try and make that work later on!
  299.  
  300.  
  301. New features in V4.1!
  302. ---------------------
  303.  
  304. 1)   I decided that I really ought to make the program work.
  305.  
  306.  
  307. New features in V4!
  308. -------------------
  309.  
  310. 1)   I rewrote the program. Nearly all the code is new, and the program now
  311.      uses it's own userfile format. Also included is a program to let you
  312.      browse the userfile. Note that "Userfile" refers to the new file
  313.      format, "Userlist" refers to the old one. Two many new features to list
  314.      in full here - most are covered in the XUC.CTL file. Users who have
  315.      used V3 or before should read this and not just blunder into it!
  316.  
  317.  
  318. Money, luvely Money!!!
  319. ----------------------
  320.  
  321.   Well, I've already mentioned (somewhere up there) the price for this fine
  322. piece of software. No need to impress on you further that if you use this
  323. program you will feel utterly low and depressed until you send me 5 quid is
  324. there? Please make all cheques payable to Michael Barnes. I won't accept
  325. money from abroad in any form other than cash unless it also covers the bank
  326. charges. It's probably easiest to buy a five pound note from your local
  327. bank, shove it between two bits of paper so that it isn't too obvious, and
  328. send that.
  329.   As promised somewhere further up the page, here is the address to send all
  330. of that money which I just know you're gonna be reaching into your pockets
  331. for as soon as you get your trousers on:
  332.  
  333.                               Artwork Software
  334.                               67, Heath Road,     
  335.                               Holtspur,
  336.                               Beaconsfield,
  337.                               Bucks.
  338.                               HP9 1DG.
  339.                               England.
  340.  
  341.   If you're very poor, but just happen to have a spare PC (with a hard disk
  342. and preferably a colour monitor) just lying around somewhere collecting
  343. dust, feel free to send that along instead. 
  344.  
  345.  
  346. File Formats
  347. ------------
  348.  
  349. I meant to include this in V4, but forgot...
  350.  
  351. The UserFile.Xuc file format:
  352.  
  353. Type URec = Record
  354.               First:String[20];
  355.               Last:String[20];
  356.               Zone:Word;
  357.               Net:Word;
  358.               Node:Word;
  359.               Point:LongInt;
  360.               Year:Word;
  361.               Month:Byte;
  362.               Day:Byte;
  363.               Comment:Longint;
  364.             End;
  365.  
  366. The Comments.Xuc file format:
  367.  
  368.      Comm = Record
  369.               Message:String[50];
  370.               User:Longint;
  371.             End;
  372.  
  373. If you want to include the XUC format in a program you're writing, please go
  374. ahead. I'd like to know about it, but that's up to you really. It's a fairly
  375. simple format but seems to work quite well.
  376.  
  377.  
  378. Registered Users
  379. ----------------
  380.  
  381. My profound thanks (and the thanks of my bank manager) go to:
  382.  
  383.                            Steve Dixon
  384.                            John Buckley
  385.                            Paul Carrol
  386.                            Ivar Peterson
  387.                            Daan Van.Rooijen
  388.                            Jeroen Smulders 
  389.  
  390.                                       for their registration of XUC. And may
  391. I say that with the money received I have established a private army which
  392. will track down and kill anyone who decides not to register... Eh? Oh well,
  393. tough - I've said it already.
  394.  
  395. Other Stuff
  396. -----------
  397.  
  398. 1)   Address Master Version 2 - marvellous Address Book program. Absolutely
  399.      brilliant. Far too many features to do the program justice here, but
  400.      included is Word Perfect mail merge support, scrolling menus, full
  401.      colour selection, label printing, etc etc. Freq as AdMaster.
  402.  
  403. 2)   NewsView - Newsfile creation program for sysops. Rather handy and easy
  404.      to use. It allows you to enter some text and a title to post as a news
  405.      item, and then the program adds this at the top of the news file
  406.      (News.Ans and News.Asc on QBBS - but you can define it to any name you
  407.      like) in both ansi and ascii format. You can specify how many news
  408.      items you want kept, and the program automatically only keeps as many
  409.      as you tell it to. This is a definate must for sysops.
  410.  
  411. 3)   StoryMan on-line story creator. This one's really good - it allows
  412.      users to add to a story, which builds up as each user decides to add a
  413.      bit. Because it's written by different people, it can turn out very
  414.      funny. This program was written for QBBS/RA systems, but can be
  415.      modified for other systems that don't use the Dorinfo1.Def file.
  416.  
  417.   For more information Netmail me, Michael Barnes, at 2:252/125 - or write
  418. to the address given above.
  419.  
  420. Michael Barnes - Owner, Chief Programmer, and Tea boy of Artwork Software.
  421.                                      
  422.                               _ ()
  423.                               '\/\
  424.                                 /|^
  425.                                _| \   (the Author - not a nancy boy, it
  426.                                        just looks that way (but not in real
  427.                                        life!))
  428.  
  429.                                 ┌─┬───┬─┐
  430.                                 ├─┘ _ └─┤rtwork
  431.                                 │  (_)  │
  432.                                 │ ┌───┐ │  .
  433.                                 │ │■ █│ │ /
  434.                                 └─┴───┴─┘/
  435.                                          \
  436.                                           \ oftware
  437.                                           /
  438.                                         ./
  439.  
  440.            "Quality Shareware software for the IBM Compatible PC"
  441.  
  442.  
  443.   Thank you for using Artwork Software programs... I hope I will soon be
  444. able to thank you for buying Artwork Software programs! I also hope,
  445. fervently, that the quality and usefulness of this program is enough to
  446. encourage you to register - if not, then nobody's forcing you to use it! If
  447. you think it's a crap program, feel free to tell me so.
  448.  
  449.   This documentation, the XUC program, and everything else in the XUC
  450. zipfile (XUC1.Zip, XUC2.Zip, XUC3.Zip, XUC4.Zip, XUC41.Zip or XUC42.Zip) are
  451. (C) Copyright Artwork Software 1990,1991.